/*
 * Copyright 2024-2025 Embabel Software, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.embabel.agent.rag.ingestion

import com.embabel.agent.rag.model.Retrievable

/**
 * Allow enhancement of retrievable objects when they are stored,
 * or actions to be taken on them.
 */
interface RetrievableEnhancer {

    /**
     * Enhance this retrievable.
     * Will be called before the retrievable is persisted.
     * Implementations may return the same instance or a modified copy.
     * Typical usages are to add metadata or modify content:
     * for example, to add a summary from context.
     */
    fun <T : Retrievable> enhance(retrievable: T): T
}
